/* ========================================================================
 * Copyright (c) 2005-2019 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 * 
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using System.Collections.Generic;
using System.Text;
using Opc.Ua;

namespace Quickstarts.HistoricalEvents.Client
{
    /// <summary>
    /// Stores information about an event field used in a subscription.
    /// </summary>
    public class FilterDefinitionField
    {
        /// <summary>
        /// A display name for the field.
        /// </summary>
        public string DisplayName;

        /// <summary>
        /// A description for the field.
        /// </summary>
        public string Description;

        /// <summary>
        /// The field data type.
        /// </summary>
        public NodeId DataType;

        /// <summary>
        /// The field value rank.
        /// </summary>
        public int ValueRank;

        /// <summary>
        /// A display name for the field data type.
        /// </summary>
        public string DataTypeDisplayName;

        /// <summary>
        /// The built in type represnted by the data type.
        /// </summary>
        public BuiltInType BuiltInType;

        /// <summary>
        /// The operand that describes the field.
        /// </summary>
        public SimpleAttributeOperand Operand;

        /// <summary>
        /// Any filter criteria applied to the field.
        /// </summary>
        public FilterOperator FilterOperator;

        /// <summary>
        /// Any filter criteria applied to the field.
        /// </summary>
        public Variant FilterValue;

        /// <summary>
        /// Whether the field appears in the list view.
        /// </summary>
        public bool ShowColumn;
    }
}
